.. _notifymention:

Notify mention
==============

:superscript:`Workflowtasksnotifymention`

.. image:: ../../_images/notifymention/notifymention_001.png
   :class: with-shadow
   :width: 400px
   :alt: workflow editing

.. image:: ../../_images/notifymention/notifymention_002.png
   :class: with-shadow
   :width: 400px
   :alt: workflow task editing

This workflow allows to create a notify if some YetiForce user is mentioned in some comment.
The workflow is available only on `ModComments` module.

=================
Workflow creation
=================

Create a new workflow on `ModComments` module.
The available execution conditions are:

- :guilabel:`Creating record`
- :guilabel:`Modifying record`
- :guilabel:`Every time a record is saved (eg. creating, modifying)`
- :guilabel:`Only once, when all conditions are met`
- :guilabel:`Deleting record`

============
Task details
============

Recipient type
--------------

| The current version provides only Users as option.
| Future development could be to provide notifications to leads, accounts, contacts, vendors and partners.

Include/exclude recipients
--------------------------

Here you can set users that will recieve notification and not.

- :guilabel:`never notify the following`: users selected here will never receive notifications from mentions
- :guilabel:`notify only the following`: only users selected here will receive notifications from mentions

Notification module
-------------------

| The module on which the workflow task runs.
| Only comments on the records of this module will be processed to send a notification to a mentioned user.

Title
-----

| The title of the notification.
| System variables can be used.

Message
-------

| The message of the notification.
| System variables can be used.